/*
 * Copyright 2011-2017 JacobLee007
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.honeybees.intellij.javadocs.configuration;

import com.honeybees.intellij.javadocs.model.settings.JavaDocSettings;
import com.intellij.openapi.components.ApplicationComponent;
import org.jetbrains.annotations.Nullable;

/**
 * The interface Java doc configuration.
 *
 * @author Sergey Timofiychuk
 */
public interface JavaDocConfiguration extends ApplicationComponent {

    /**
     * The constant COMPONENT_VERSION.
     */
    String COMPONENT_VERSION = "0.0.1";

    /**
     * The constant COMPONENT_NAME.
     */
    String COMPONENT_NAME = "JavaDocConfiguration_" + COMPONENT_VERSION;

    /**
     * Gets the configuration.
     *
     * @return the Configuration
     */
    @Nullable
    JavaDocSettings getConfiguration();

}
